feat: Add database name to annotations in multi-DB environments #272
+85
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Problem In a multi-database environment, it can be confusing to determine which database a model's table belongs to just by looking at the schema annotations. This can lead to developers mistakenly thinking a table is missing when it simply resides in a different database. ## Solution This commit introduces a new line in the schema information block that conditionally displays the database name. - In multi-database environments, the database name is now shown to provide clarity: # == Schema Information # # Table name: tasks # Database name: second_database # # ... - In single-database environments, the database name is not displayed to avoid unnecessary clutter. Refs drwl#254
drwl
approved these changes
Oct 20, 2025
Owner
drwl
left a comment
drwl
left a comment
There was a problem hiding this comment.
This looks good to me. Seems like the ActiveRecord APIs were added in Rails 6 so we should be good:
https://www.bigbinary.com/blog/rails-6-changed-activerecord-base-configurations-result-to-an-object
Contributor
Author
|
Thank you for taking the time to review this despite your busy schedule ! |
t27duck
added a commit
to t27duck/annotaterb
that referenced
this pull request
Oct 21, 2025
New "modern" Rails apps default to using the "solid trifecta" of solidqueue, cache, and cable. The generator defaults to creating a separate database for each feature meaning all new Rails apps would be multi-database out of the box. With the introduction of drwl#272 all Rails apps with the trifecta configured will have "Database: primary" appended to every annotated file even though there's really one database the developer cares about as the other gems provide their own models and handling. This adds an "ignore_multi_database_name" configuration option which disables including the database name even if the app has multiple databases.
drwl
pushed a commit
that referenced
this pull request
Oct 22, 2025
New "modern" Rails apps default to using the "solid trifecta" of solidqueue, cache, and cable. The generator defaults to creating a separate database for each feature meaning all new Rails apps would be multi-database out of the box. With the introduction of #272 all Rails apps with the trifecta configured will have "Database: primary" appended to every annotated file even though there's really one database the developer "cares" about as the other gems provide their own models and handling. This adds an "ignore_multi_database_name" configuration option which disables including the database name even if the app has multiple databases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
In a multi-database environment, it can be confusing to determine which database a model's table belongs to just by looking at the schema annotations. This can lead to developers mistakenly thinking a table is missing when it simply resides in a different database.
Solution
This commit introduces a new line in the schema information block that conditionally displays the database name.
Refs #254
I really enjoy contributing to this gem and hope to contribute even more.
Thank you for always maintaining it! 👍